Skip to content

Add Helm chart documentation and improve values.yaml annotations#1390

Merged
imilchev merged 1 commit intomainfrom
claude/add-helm-readme-generator-hnFCN
Feb 16, 2026
Merged

Add Helm chart documentation and improve values.yaml annotations#1390
imilchev merged 1 commit intomainfrom
claude/add-helm-readme-generator-hnFCN

Conversation

@chris-rock
Copy link
Copy Markdown
Member

Summary

This PR adds comprehensive documentation for the Mondoo Operator Helm chart and improves the values.yaml file with structured annotations for automatic documentation generation.

Key Changes

  • Added README.md: Created a comprehensive Helm chart README with installation instructions, prerequisites, and a complete parameters table documenting all configurable values
  • Enhanced values.yaml: Added Helm documentation annotations (@section and @param) to all configuration parameters for better organization and automated documentation generation
  • Added documentation generation tooling: Implemented a new helm/docs Makefile target that uses the Bitnami readme-generator-for-helm tool to automatically generate the README from values.yaml annotations

Implementation Details

  • The README includes sections for Controller Manager Configuration, Kubernetes Resources Scanning, General Configuration, Manager Config, Metrics Service, and Pre-delete Cleanup Hook Configuration
  • All parameters are documented with descriptions and default values in a structured table format
  • The Makefile target automatically clones and installs the readme-generator-for-helm tool on first use
  • Documentation annotations follow Helm best practices with @section headers for logical grouping and @param tags for individual parameters
  • The cleanup hook configuration section includes helpful comments explaining its purpose in the uninstall process

https://claude.ai/code/session_01HTHQYrFGw5L4Wn3BxCU5hk

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 13, 2026

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@github-actions

This comment has been minimized.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 13, 2026

Test Results

  5 files  ±0   42 suites  ±0   46m 27s ⏱️ + 3m 46s
302 tests ±0  302 ✅ ±0  0 💤 ±0  0 ❌ ±0 
342 runs  ±0  340 ✅ ±0  2 💤 ±0  0 ❌ ±0 

Results for commit f34ae3a. ± Comparison against base commit 3b0a735.

♻️ This comment has been updated with latest results.

@chris-rock chris-rock force-pushed the claude/add-helm-readme-generator-hnFCN branch from 8f6ff01 to 73a1cb7 Compare February 13, 2026 18:49
Annotate values.yaml with @param and @section tags recognized by the
bitnami readme-generator-for-helm tool, create a chart README.md with
auto-generated parameter tables, and add a `make helm/docs` target
that clones and runs the generator. Add SResources to the spellcheck
expect list.
@chris-rock chris-rock force-pushed the claude/add-helm-readme-generator-hnFCN branch from 73a1cb7 to f34ae3a Compare February 13, 2026 18:53
@imilchev imilchev merged commit af62f04 into main Feb 16, 2026
25 checks passed
@imilchev imilchev deleted the claude/add-helm-readme-generator-hnFCN branch February 16, 2026 08:25
@github-actions github-actions Bot locked and limited conversation to collaborators Feb 16, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants